Add comprehensive Javadoc to XmlNodeBuilder#11925
Merged
gnodet merged 1 commit intoMay 20, 2026
Merged
Conversation
Document the multi-document stream reading behavior, whitespace trimming semantics, empty vs self-closing element handling, and child-vs-text-value semantics. Also document all public build() overloads and the InputLocationBuilder interface. Closes apache#11526
gnodet
approved these changes
May 20, 2026
Contributor
gnodet
left a comment
gnodet
left a comment
There was a problem hiding this comment.
Clean, well-done javadoc PR. The documentation accurately describes all key behavioral points:
- Multi-document reading — matches the test in
XmlNodeBuilderTest.testReadMultiDoc() - Whitespace trimming — matches
DEFAULT_TRIM = trueand thexml:space="preserve"check - Empty vs self-closing — matches the ternary:
emptyTag ? null : "" - Child vs text — matches the
children == null ? (value ...) : nulllogic @throws IllegalStateException— matches the throw at end of the corebuildmethod@deprecatedjavadoc tag — correctly pairs with the existing@Deprecatedannotation and referencesXmlService
This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.
Claude Code on behalf of Guillaume Nodet
|
@gnodet Please assign appropriate label to PR according to the type of change. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the previously under-documented XmlNodeBuilder class, covering multi-document stream reading behavior, whitespace trimming semantics, empty vs self-closing element handling, and all public method overloads with proper @param, @return, and @throws tags.
Closes #11526